WatchList Tool – Methods

The following table lists and describes methods of the WatchList Tool. Methods are accessed using the control's script editor.

Note: If a property or method in the script editor has two forms with the same name, one form exists for legacy support and the other form is current. When possible, use the current form. To select the current form, append .X. to the name of the object to which the property or method applies, and then enter the property or method name. For instance, enter MyObject.X.MyProperty. If a property or method in the script editor has only one form, the X method might or might not apply. The column in the table below indicates whether or not a property or method is accessible using the X method.

Method		Description
AboutBox	Yes	The AboutBox method displays an About dialog box for the control.
AcknowledgeReminder	Yes
AddPoint	Yes
AddReminder	Yes
AlarmAcknowledge	No	The AlarmAcknowledge method acknowledges an alarm.
CaptureMouse	No	The CaptureMouse method forces mouse events to fire. While the mouse is being captured, mouse events will continue to fire on the capturing entity regardless of current mouse position. This function better facilitates dragging objects on views, such as splitters to allow for more flexible layout capabilities. Automatically released on left mouse button release. Context menus are not displayed while capturing. If the function is called on a windowed tool, the function sets capture to that window. If called on a non-windowed tool, it sets capture to The View and tracks which tool is "captured," altering its mouse event functions to always fire for that tool until released.
Clear	Yes	The Clear method clears the contents and values of the object.
ClearMenu	No	The ClearMenu method clears all custom items from the context menu. Syntax `ClearMenu()` Parameters This method takes no parameters. Return Values This method returns no values.
EditPoint	Yes
ExportToXml	Yes	The ExportToXml method dumps the data in the dictionary to an XML string.
FacilityConfig	No
GetDlgCtrlID	No	The GetDlgCtrlID method returns the numeric resource identifier of the control within TheView.
GetGroup	No	The GetGroup method returns the object group to which an object belongs, and returns null if the object does not belong to a group. The GroupID property returns the GroupID. Calling GetGroup is equivalent to calling TheView GetGroupByID and passing the value of the object’s GroupID property, and is provided for convenience.
HistoryAlarms	Yes	The HistoryAlarms method calls the Alarm History dialog box, which shows the alarm history of an individual alarm, and provides options for showing only particular types of alarm events. See Alarm History for more information.
HistoryAlarmsByRow	No
HistoryValues	Yes	The HistoryValues method calls the History Values dialog box, which shows all the history records for a given point, including additional information if the history name came from the PNT. See History Records for more information.
HistoryValuesByRow	No
ImportFromXml	Yes	The ImportFromXml method loads data from the dictionary object in XML form. The Boolean parameter in ImportFromXml determines whether or not duplicate points will be replaced from the stored XML.
IsSelected	No	The IsSelected method indicates if the tool or control is selected. Can be used with [ContextMenuAutoSelect].
LayerName	No	The LayerName method gets the name of the layer on which the object resides.
Move	No	The Move method moves an object by the specified amount, relative to its current position.
OnUpdate	No	The OnUpdate method updates the control to ensure that any property modifications have taken effect.
OnUpdateResize	No	The OnUpdateResize method updates the control to ensure that any modifications to its boundary have taken effect.
OnUpdateStyle	No	The OnUpdateStyle method updates the control to ensure that any modifications to its style properties have taken effect.
PointConfigAlarmSettings	Yes
PointConfigAlarmSettingsByRow	No
PointConfigAlarmSuppression	Yes
PointConfigAlarmSuppressionByRow	No
PointConfigAll	Yes
PointConfigAllByRow	No
PointConfigComments	Yes
PointConfigCommentsByRow	No
PointConfigQuestionable	Yes
PointConfigQuestionableByRow	No
RegisterPointForChangeNotice	No	The RegisterPointForChangeNotice method registers an unrelated point on a screen that may change its value. Used in conjunction with EventPointChange.
RemoveMenuItem	No
RemovePoint	Yes
RunInitialize	No	The RunInitialize method runs the object’s EventInitialize event code.
RunPumpData	No	This method is not used.
Select	No	The Select method selects the tool or control. "True" to select, "false" to deselect. Can be used with [ContextMenuAutoSelect].
SetFocus	No	The SetFocus method sets the focus to the control.
SetMenuItem	No
SetSubMenuItem	No
ShowConfiguration	No
ShowCurrentValue	Yes
ShowCurrentValueByRow	No
TrendAddPoint	Yes
TrendAddPointByRow	No
TrendRemovePoint	Yes
TrendRemovePointByRow	No
TrendSinglePoint	Yes
TrendSinglePointByRow	No
TrendSinglePointRollup	Yes
TrendSinglePointRollupByRow	No
Update	Yes
X	No	The X method returns an object that lists properties and methods specific to an ActiveX control. This method is only available for some ActiveX controls.

Method

Description

AboutBox

Yes

The AboutBox method displays an About dialog box for the control.

AcknowledgeReminder

Yes

AddPoint

Yes

AddReminder

Yes

AlarmAcknowledge

The AlarmAcknowledge method acknowledges an alarm.

CaptureMouse

The CaptureMouse method forces mouse events to fire. While the mouse is being captured, mouse events will continue to fire on the capturing entity regardless of current mouse position. This function better facilitates dragging objects on views, such as splitters to allow for more flexible layout capabilities. Automatically released on left mouse button release. Context menus are not displayed while capturing. If the function is called on a windowed tool, the function sets capture to that window. If called on a non-windowed tool, it sets capture to The View and tracks which tool is "captured," altering its mouse event functions to always fire for that tool until released.

Clear

Yes

The Clear method clears the contents and values of the object.

ClearMenu

The ClearMenu method clears all custom items from the context menu.

Syntax

ClearMenu()

Parameters

This method takes no parameters.

Return Values

This method returns no values.

EditPoint

Yes

ExportToXml

Yes

The ExportToXml method dumps the data in the dictionary to an XML string.

FacilityConfig

GetDlgCtrlID

The GetDlgCtrlID method returns the numeric resource identifier of the control within TheView.

GetGroup

The GetGroup method returns the object group to which an object belongs, and returns null if the object does not belong to a group. The GroupID property returns the GroupID. Calling GetGroup is equivalent to calling TheView GetGroupByID and passing the value of the object’s GroupID property, and is provided for convenience.

HistoryAlarms

Yes

The HistoryAlarms method calls the Alarm History dialog box, which shows the alarm history of an individual alarm, and provides options for showing only particular types of alarm events. See Alarm History for more information.

HistoryAlarmsByRow

HistoryValues

Yes

The HistoryValues method calls the History Values dialog box, which shows all the history records for a given point, including additional information if the history name came from the PNT. See History Records for more information.

HistoryValuesByRow

ImportFromXml

Yes

The ImportFromXml method loads data from the dictionary object in XML form. The Boolean parameter in ImportFromXml determines whether or not duplicate points will be replaced from the stored XML.

IsSelected

The IsSelected method indicates if the tool or control is selected. Can be used with [ContextMenuAutoSelect].

LayerName

The LayerName method gets the name of the layer on which the object resides.

Move

The Move method moves an object by the specified amount, relative to its current position.

OnUpdate

The OnUpdate method updates the control to ensure that any property modifications have taken effect.

OnUpdateResize

The OnUpdateResize method updates the control to ensure that any modifications to its boundary have taken effect.

OnUpdateStyle

The OnUpdateStyle method updates the control to ensure that any modifications to its style properties have taken effect.

PointConfigAlarmSettings

Yes

PointConfigAlarmSettingsByRow

PointConfigAlarmSuppression

Yes

PointConfigAlarmSuppressionByRow

PointConfigAll

Yes

PointConfigAllByRow

PointConfigComments

Yes

PointConfigCommentsByRow

PointConfigQuestionable

Yes

PointConfigQuestionableByRow

RegisterPointForChangeNotice

The RegisterPointForChangeNotice method registers an unrelated point on a screen that may change its value. Used in conjunction with EventPointChange.

RemoveMenuItem

RemovePoint

Yes

RunInitialize

The RunInitialize method runs the object’s EventInitialize event code.

RunPumpData

This method is not used.

Select

The Select method selects the tool or control. "True" to select, "false" to deselect. Can be used with [ContextMenuAutoSelect].

SetFocus

The SetFocus method sets the focus to the control.

SetMenuItem

SetSubMenuItem

ShowConfiguration

ShowCurrentValue

Yes

ShowCurrentValueByRow

TrendAddPoint

Yes

TrendAddPointByRow

TrendRemovePoint

Yes

TrendRemovePointByRow

TrendSinglePoint

Yes

TrendSinglePointByRow

TrendSinglePointRollup

Yes

TrendSinglePointRollupByRow

Update

Yes

The X method returns an object that lists properties and methods specific to an ActiveX control. This method is only available for some ActiveX controls.